home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2000 January / Macworld (2000-01).dmg / Shareware World / Utilities / Text processing / Excalibur.sea / Excalibur / manual / url.sty (.txt) < prev   
LaTeX Document  |  1999-10-13  |  15KB  |  266 lines
  1. % url.sty  ver 1.4    02-Mar-1999   Donald Arseneau   asnd@triumf.ca
  2. % Copyright 1996-1999 Donald Arseneau,  Vancouver, Canada.
  3. % This program can be used, distributed, and modified under the terms
  4. % of the LaTeX Project Public License.
  5. % A form of \verb that allows linebreaks at certain characters or
  6. % combinations of characters, accepts reconfiguration, and can usually
  7. % be used in the argument to another command.  It is intended for email
  8. % addresses, hypertext links, directories/paths, etc., which normally
  9. % have no spaces.  The font may be selected using the \urlstyle command,
  10. % and new url-like commands can be defined using \urldef.
  11. % Usage:    Conditions:
  12. % \url{ }   If the argument contains any "%", "#", or "^^", or ends with
  13. %           "\", it can't be used in the argument to another command.
  14. %           The argument must not contain unbalanced braces.
  15. % \url|  |  ...where "|" is any character not used in the argument and not
  16. %           "{" or a space.  The same restrictions as above except that the
  17. %           argument may contain unbalanced braces.
  18. % \xyz      for "\xyz" a defined-url;  this can be used anywhere, no matter
  19. %           what characters it contains.
  20. % See further instructions after "\endinput"
  21. \def\Url@ttdo{% style assignments for tt fonts or T1 encoding
  22. \def\UrlBreaks{\do\.\do\@\do\\\do\/\do\!\do\_\do\|\do\%\do\;\do\>\do\]%
  23.  \do\)\do\,\do\?\do\'\do\+\do\=}%
  24. \def\UrlBigBreaks{\do\:\do@url@hyp}%
  25. \def\UrlNoBreaks{\do\(\do\[\do\{\do\<}% (unnecessary)
  26. \def\UrlSpecials{\do\ {\ }}%
  27. \def\UrlOrds{\do\*\do\-\do\~}% any ordinary characters that aren't usually
  28. \def\Url@do{% style assignments for OT1 fonts except tt
  29. \def\UrlBreaks{\do\.\do\@\do\/\do\!\do\%\do\;\do\]\do\)\do\,\do\?\do\+\do\=}%
  30. \def\UrlBigBreaks{\do\:\do@url@hyp}%
  31. \def\UrlNoBreaks{\do\(\do\[\do\{}% prevents breaks after *next* character
  32. \def\UrlSpecials{\do\<{\langle}\do\>{\mathbin{\rangle}}\do\_{\_%
  33.  \penalty\@m}\do\|{\mid}\do\{{\lbrace}\do\}{\mathbin{\rbrace}}\do
  34.  \\{\mathbin{\backslash}}\do\~{\raise.6ex\hbox{\m@th$\scriptstyle\sim$}}\do
  35.  \ {\ }}%
  36. \def\UrlOrds{\do\'\do\"\do\-}%
  37. \def\url@ttstyle{%
  38. \@ifundefined{selectfont}{\def\UrlFont{\tt}}{\def\UrlFont{\ttfamily}}\Url@ttdo
  39. \def\url@rmstyle{%
  40. \@ifundefined{selectfont}{\def\UrlFont{\rm}}{\def\UrlFont{\rmfamily}}\Url@do
  41. \def\url@sfstyle{%
  42. \@ifundefined{selectfont}{\def\UrlFont{\sf}}{\def\UrlFont{\sffamily}}\Url@do
  43. \def\url@samestyle{\ifdim\fontdimen\thr@@\font=\z@ \url@ttstyle \else
  44.   \url@rmstyle \fi \def\UrlFont{}}
  45. \@ifundefined{strip@prefix}{\def\strip@prefix#1>{}}{}
  46. \@ifundefined{verbatim@nolig@list}{\def\verbatim@nolig@list{\do\`}}{}
  47. \def\Url{%
  48.  \begingroup \let\url@moving\relax\relax \endgroup
  49.  \ifmmode\@nomatherr$\fi
  50.  \UrlFont $\fam\z@ \textfont\z@\font
  51.  \let\do\@makeother \dospecials % verbatim catcodes
  52.  \catcode`{\@ne \catcode`}\tw@ \catcode`\ 10 % except braces and spaces
  53.  \medmuskip0mu \thickmuskip\medmuskip \thinmuskip\medmuskip
  54.  \@tempcnta\fam\multiply\@tempcnta\@cclvi
  55.  \let\do\set@mathcode \UrlOrds % ordinary characters that were special
  56.  \advance\@tempcnta 8192 \UrlBreaks % bin
  57.  \advance\@tempcnta 4096 \UrlBigBreaks % rel
  58.  \advance\@tempcnta 4096 \UrlNoBreaks % open
  59.  \let\do\set@mathact \UrlSpecials % active
  60.  \let\do\set@mathnolig \verbatim@nolig@list % prevent ligatures
  61.  \@ifnextchar\bgroup\Url@z\Url@y}
  62. \def\Url@y#1{\catcode`{11 \catcode`}11
  63.   \def\@tempa##1#1{\Url@z{##1}}\@tempa}
  64. \def\Url@z#1{\def\@tempa{#1}\expandafter\expandafter\expandafter\Url@Hook
  65.   \expandafter\strip@prefix\meaning\@tempa\UrlRight\m@th$\endgroup}
  66. \def\Url@Hook{\UrlLeft}
  67. \let\UrlRight\@empty
  68. \let\UrlLeft\@empty
  69. \def\set@mathcode#1{\count@`#1\advance\count@\@tempcnta\mathcode`#1\count@}
  70. \def\set@mathact#1#2{\mathcode`#132768 \lccode`\~`#1\lowercase{\def~{#2}}}
  71. \def\set@mathnolig#1{\ifnum\mathcode`#1<32768
  72.    \lccode`\~`#1\lowercase{\edef~{\mathchar\number\mathcode`#1_{\/}}}%
  73.    \mathcode`#132768 \fi}
  74. \def\urldef#1#2{\begingroup \setbox\z@\hbox\bgroup
  75.   \def\Url@z{\Url@def{#1}{#2}}#2}
  76. \expandafter\ifx\csname DeclareRobustCommand\endcsname\relax
  77.   \def\Url@def#1#2#3{\m@th$\endgroup\egroup\endgroup
  78.     \def#1{#2{#3}}}
  79. \else
  80.   \def\Url@def#1#2#3{\m@th$\endgroup\egroup\endgroup
  81.     \DeclareRobustCommand{#1}{#2{#3}}}
  82. \def\urlstyle#1{\csname url@#1style\endcsname}
  83. % Sample (and default) configuration:
  84. \newcommand\url{\begingroup \Url}
  85. % picTeX defines \path, so declare it optionally:
  86. \@ifundefined{path}{\newcommand\path{\begingroup \urlstyle{tt}\Url}}{}
  87. % too many styles define \email like \address, so I will not define it.
  88. % \newcommand\email{\begingroup \urlstyle{rm}\Url}
  89. % Process LaTeX \package options
  90. \urlstyle{tt}
  91. \let\Url@sppen\@M
  92. \def\do@url@hyp{}% by default, no breaks after hyphens
  93. \@ifundefined{ProvidesPackage}{}{
  94.   \ProvidesPackage{url}[1999/03/02 \space ver 1.4 \space
  95.        Verb mode for urls, email addresses, and file names]
  96.   \DeclareOption{hyphens}{\def\do@url@hyp{\do\-}}% allow breaks after hyphens
  97.   \DeclareOption{obeyspaces}{\let\Url@Hook\relax}% a flag for later
  98.   \DeclareOption{spaces}{\let\Url@sppen\relpenalty}
  99.   \DeclareOption{T1}{\let\Url@do\Url@ttdo}
  100.   \ProcessOptions
  101. \ifx\Url@Hook\relax % [obeyspaces] was declared
  102.   \def\Url@Hook#1\UrlRight\m@th{\edef\@tempa{\noexpand\UrlLeft
  103.     \Url@retain#1\Url@nosp\, }\@tempa\UrlRight\m@th}
  104.   \def\Url@retain#1 {#1\penalty\Url@sppen\ \Url@retain}
  105.   \def\Url@nosp\,#1\Url@retain{}
  106. \edef\url@moving{\csname Url Error\endcsname}
  107. \expandafter\edef\url@moving
  108.  {\csname url used in a moving argument.\endcsname}
  109. \expandafter\expandafter\expandafter \let \url@moving\undefined 
  110. \endinput
  111. % url.sty  ver 1.4   02-Mar-1999   Donald Arseneau   asnd@reg.triumf.ca
  112. % This package defines "\url", a form of "\verb" that allows linebreaks,
  113. % and can often be used in the argument to another command.  It can be
  114. % configured to print in different formats, and is particularly useful for
  115. % hypertext links, email addresses, directories/paths, etc.  The font may
  116. % be selected using the "\urlstyle" command and pre-defined text can be
  117. % stored with the "\urldef" command. New url-like commands can be defined,
  118. % and a "\path" command is provided this way.
  119. % Usage:    Conditions:
  120. % \url{ }   If the argument contains any "%", "#", or "^^", or ends with
  121. %           "\", it can't be used in the argument to another command.
  122. %           The argument must not contain unbalanced braces.
  123. % \url|  |  ...where "|" is any character not used in the argument and not
  124. %           "{" or a space.  The same restrictions as above except that the
  125. %           argument may contain unbalanced braces.
  126. % \xyz      for "\xyz" a defined-url;  this can be used anywhere, no matter
  127. %           what characters it contains.
  128. % The "\url" command is fragile, and its argument is likely to be very
  129. % fragile, but a defined-url is robust.
  130. % Package Option:  obeyspaces
  131. % Ordinarily, all spaces are ignored in the url-text.  The "[obeyspaces]"
  132. % option allows spaces, but may introduce spurious spaces when a url
  133. % containing "\" characters is given in the argument to another command.
  134. % So if you need to obey spaces you can say "\usepackage[obeyspaces]{url}",
  135. % and if you need both spaces and backslashes, use a `defined-url' for
  136. % anything with "\".
  137. % Package Option:  hyphens
  138. % Ordinarily, breaks are not allowed after "-" characters because this
  139. % leads to confusion. (Is the "-" part of the address or just a hyphen?)
  140. % The package option "[hyphens]" allows breaks after explicit hyphen
  141. % characters.  The "\url" command will *never ever* hyphenate words.
  142. % Package Option:  spaces
  143. % Likewise, breaks are not usually allowed after spaces under the
  144. % "[obeyspaces]" option, but giving the options "[obeyspaces,spaces]"
  145. % will allow breaks at those spaces.
  146. % Package Option:  T1
  147. % This signifies that you will be using T1-encoded fonts which contain
  148. % some characters missing from most older (OT1) encoded TeX fonts.  This
  149. % changes the default definition for "\urlstyle{rm}".
  150. % Defining a defined-url:
  151. % Take for example the email address "myself%node@gateway.net" which could
  152. % not be given (using "\url" or "\verb") in a caption or parbox due to the
  153. % percent sign.  This address can be predefined with
  154. %    \urldef{\myself}\url{myself%node@gateway.net}   or
  155. %    \urldef{\myself}\url|myself%node@gateway.net|
  156. % and then you may use "\myself" instead of "\url{myself%node@gateway.net}"
  157. % in an argument, and even in a moving argument like a caption because a
  158. % defined-url is robust.
  159. % Style:
  160. % You can switch the style of printing using "\urlstyle{tt}", where "tt"
  161. % can be any defined style.  The pre-defined styles are "tt", "rm", "sf",
  162. % and "same" which all allow the same linebreaks but different fonts --
  163. % the first three select a specific font and the "same" style uses the
  164. % current text font.  You can define your own styles with different fonts
  165. % and/or line-breaking by following the explanations below.  The "\url"
  166. % command follows whatever the currently-set style dictates.
  167. % Alternate commands:
  168. % It may be desireable to have different things treated differently, each
  169. % in a predefined style; e.g., if you want directory paths to always be
  170. % in tt and email addresses to be rm, then you would define new url-like
  171. % commands as follows:
  172. %    \newcommand\email{\begingroup \urlstyle{rm}\Url}
  173. %    \newcommand\directory{\begingroup \urlstyle{tt}\Url}
  174. % You must follow this format closely, and NOTE that the final command is
  175. % "\Url", not "\url".  In fact, the "\directory" example is exactly the
  176. % "\path" definition which is pre-defined in the package.  If you look
  177. % above, you will see that "\url" is defined with
  178. %    \newcommand\url{\begingroup \Url}
  179. % I.e., using whatever url-style has been selected.
  180. % You can make a defined-url for these other styles, using the usual
  181. % "\urldef" command as in this example:
  182. %    \urldef{\myself}{\email}{myself%node.domain@gateway.net}
  183. % which makes "\myself" act like "\email{myself%node.domain@gateway.net}",
  184. % if the "\email" command is defined as above.  The "\myself" command
  185. % would then be robust.
  186. % Defining styles:
  187. % Before describing how to customize the printing style, it is best to
  188. % mention something about the unusual implementation of "\url".  Although
  189. % the material is textual in nature, and the font specification required
  190. % is a text-font command, the text is actually typeset in *math* mode.
  191. % This allows the context-sensitive linebreaking, but also accounts for
  192. % the default behavior of ignoring spaces.  Now on to defining styles.
  193. % To change the font or the list of characters that allow linebreaks, you
  194. % could redefine the commands "\UrlFont", "\UrlBreaks", "\UrlSpecials" etc.
  195. % directly in the document, but it is better to define a new `url-style'
  196. % (following the example of "\url@ttstyle" and "\url@rmstyle") which defines
  197. % all of "\UrlBigbreaks", "\UrlNoBreaks", "\UrlBreaks", "\UrlSpecials", and
  198. % "\UrlFont".
  199. % Changing font:
  200. % The "\UrlFont" command selects the font.  The definition of "\UrlFont"
  201. % done by the pre-defined styles varies to cope with a variety of LaTeX
  202. % font selection schemes, but it could be as simple as "\def\UrlFont{\tt}".
  203. % Depending on the font selected, some characters may need to be defined
  204. % in the "\UrlSpecials" list because many fonts don't contain all the
  205. % standard input characters.
  206. % Changing linebreaks:
  207. % The list of characters that allow line-breaks is given by "\UrlBreaks"
  208. % and "\UrlBigBreaks", which have the format "\do\c" for character "c".
  209. % The differences are that `BigBreaks' have a lower penalty and have
  210. % different breakpoints when in sequence (as in "http://"): `BigBreaks'
  211. % are treated as mathrels while `Breaks' are mathbins (see The TeXbook,
  212. % p.170). In particular, a series of `BigBreak' characters will break at
  213. % the end and only at the end; a series of `Break' characters will break
  214. % after the first and after every following *pair*; there will be no
  215. % break after a `Break' character if a `BigBreak' follows.  In the case
  216. % of "http://" it doesn't matter whether ":" is a `Break' or `BigBreak' --
  217. % the breaks are the same in either case; but for DECnet nodes with "::"
  218. % it is important to prevent breaks *between* the colons, and that is why
  219. % colons are `BigBreaks'.
  220. % It is possible for characters to prevent breaks after the next following
  221. % character (I use this for parentheses).  Specify these in "\UrlNoBreaks".
  222. % You can do arbitrarily complex things with characters by making them
  223. % active in math mode (mathcode hex-8000) and specifying the definition(s)
  224. % in "\UrlSpecials".  This is used in the rm and sf styles for OT1 font
  225. % encoding to handle several characters that are not present in those
  226. % computer-modern style fonts.  See the definition of "\Url@do", which
  227. % is used by both "\url@rmstyle" and "\url@sfstyle"; it handles missing
  228. % characters via "\UrlSpecials".  The nominal format for setting each
  229. % special character "c" is: "\do\c{<definition>}", but you can include
  230. % other definitions too.
  231. % If all this sounds confusing ... well, it is!  But I hope you won't need
  232. % to redefine breakpoints -- the default assignments seem to work well for
  233. % a wide variety of applications.  If you do need to make changes, you can
  234. % test for breakpoints using regular math mode and the characters "+=(a".
  235. % Yet more flexibility:
  236. % You can also customize the verbatim text by defining "\UrlRight" and/or
  237. % "\UrlLeft", e.g., for ISO formatting of urls surrounded by "<  >", define
  238. %    \renewcommand\url{\begingroup \def\UrlLeft{<url: }\def\UrlRight{>}%
  239. %        \urlstyle{tt}\Url}
  240. % The meanings of "\UrlLeft" and "\UrlRight" are *not* reproduced verbatim.
  241. % This lets you use formatting commands there, but you must be careful not
  242. % to use TeX's special characters ("\^_%~#$&{}" etc.) improperly.
  243. % You can also define "\UrlLeft" to reprocess the verbatim text, but the
  244. % format of the definition is special:
  245. %    \def\UrlLeft#1\UrlRight{ ... do things with #1 ... }
  246. % Yes, that is "#1" followed by "\UrlRight" then the definition.  For
  247. % example, to put a hyperTeX hypertext link in the DVI file:
  248. %    \def\UrlLeft#1\UrlRight{\special{html:<a href="#1">}#1\special{html:</a>}}
  249. % Using this technique, url.sty can provide a convenient interface for
  250. % performing various operations on verbatim text.  You don't even need
  251. % to print out the argument!  For greatest efficiency in such obscure
  252. % applications, you can define a null url-style where all the lists like
  253. % "\UrlBreaks" are empty.
  254. % Revision History:
  255. % ver 1.1 6-Feb-1996: 
  256. % Fix hyphens that wouldn't break and ligatures that weren't suppressed.
  257. % ver 1.2 19-Oct-1996:
  258. % Package option for T1 encoding; Hooks: "\UrlLeft" and "\UrlRight".
  259. % ver 1.3 21-Jul-1997:
  260. % Prohibit spaces as delimiter characters; change ascii tilde in OT1.
  261. % ver 1.4 02-Mar-1999
  262. % LaTeX license; moving-argument-error
  263. % The End
  264. Test file integrity:  ASCII 32-57, 58-126:  !"#$%&'()*+,-./0123456789
  265. :;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
  266.